vcPathStatement

A vcPathStatement is a type of robot statement that can execute a set of positions. It allows you to manage a large amount of data used for robot motion planning.

See in: Overview

Module: vcRobotics

Parent: vcPositionStatement

Children -

Referenced by: vcSchemaPositionFrame.Path, vcSchemaPositionFrame.Statement

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
FrameNameField	Integer	RW	Defines the index of schema property used for labeling position in 3D world. See more The schema property should be a string data type. The default is -1. This means the position will not be labeled with its custom name rather the number of position in path.
FrameNameVisibleField	Integer	RW	Defines the index of schema property used for controlling the visibility of position label in 3D world. See more The schema property should be a Boolean data type. The default is -1. This means the labels are visible.
ProcessHandler	vcPythonProcessHandler	RW	Defines the process handler used by robot to execute path statement.
SchemaProperties	vcList	R	Gets a list of schema properties for path statement. See "Schema Properties" section for more information.
ShowReferenceFrames	Boolean	RW	Turns on/off visibility of positions marked as reference points.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
addSchemaProperties	list[Integer]	list properties	Adds a list of custom properties for each position in path statement, and then returns a list of indices for the added properties in SchemaProperties. See more The list should contain one or more value pairs Enumeration type, String name. Each pair defines a single property to add.
beginBatchUpdate	None	Integer schema_size	Sets the initial amount of schema database entries, for example 100 entries for 100 path positions. See more This is done to allocate enough memory for storing schema property values for each path position. Note: This method is required if there is no existing schema database. If the database exists, this is optional. Note: Using size value -1 doesn't allocate space for new schema items and doesn't reset current data. It only blocks notify events when items are updated between this call and EndBatchUpdate.
clearPositions	None	None	Removes all positions from path statement, thereby removing all schema database entries.
endBatchUpdate	None	Integer schema_size	Sets the final amount of schema database entries, for example 96 entries for 96 path positions. See more This is done to not allocate more memory than is needed to store schema property values for each path position.
getSchemaSize	Integer	None	Returns the total amount of entries for schema database of path statement.
getSchemaValue	object	Integer position_index, String property_name	Returns the value of schema property for path position.
removeSchemaProperties	None	list properties	Removes properties referenced by property_names list or properties list arguments
setSchemaValues	None	Integer position_index, object properties, object values	Sets one or more schema properties for path position. Note: The method should not be called when there are no rows in the schema database or if the row's index value does not exist.